Learner Management API Endpoints

#1

Learner management endpoints allow you to automate the creation and management of learners in your IQ account.

Applicable endpoints

Gathering information

GET endpoints allow you to retrieve information about learners already in your IQ account.

  1. Learners: /learners provides a full list of learners in your account with limited information.
  2. Learner details: /learners/{id} provides all learner profile details about a specific learner, plus a link to their Learner Dashboard.
  3. Groups: /learners-groups provides a full list of groups in your account, including static and dynamic groups.
  4. Group details: /learners-groups/{group_id}/learners provides a list of all learners within a specific group.

Managing learners

POST, PUT, DELETE endpoints allow you to add and manage learners in your IQ account.

  1. Learners: POST /learners allows you to create a new learner and populate all learner profile fields.
  2. Learners: PUT /learners/{id} allows you to edit an existing learner’s profile, including the learner email address.
  3. Learners: DELETE /learners/{id} allows you to remove an existing learner. This will delete all learner associated data as well.

Additional Documentation

Click here for the complete Infosec IQ Open API documentation.

Infosec IQ API Support

The Infosec IQ Open API is provided with limited support. We can provide guidance about the functionality of our API endpoints but we are unable to assist with writing code or creating integrations with other software.